<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::Dynamics&lt; ReturnType &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_dynamics.html">Dynamics</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="class_s_p_h_1_1_dynamics-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::Dynamics&lt; ReturnType &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>The base class for all dynamics This class contains the only two interface functions available for particle dynamics. An specific implementation should be realized.  
 <a href="class_s_p_h_1_1_dynamics.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="base__particle__dynamics_8h_source.html">base_particle_dynamics.h</a>&gt;</code></p>

<p>Inherits <a class="el" href="class_s_p_h_1_1_global_static_variables.html">SPH::GlobalStaticVariables</a>.</p>

<p>Inherited by <a class="el" href="class_s_p_h_1_1_particle_dynamics.html">SPH::ParticleDynamics&lt; ReturnType, BodyType, ParticlesType, MaterialType &gt;</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a343c5cd5886c1c142ec2f995449029f5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_dynamics.html#a343c5cd5886c1c142ec2f995449029f5">Dynamics</a> ()</td></tr>
<tr class="separator:a343c5cd5886c1c142ec2f995449029f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c31cbb0b72279f481468c7c0f10da8e"><td class="memItemLeft" align="right" valign="top">virtual ReturnType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_dynamics.html#a8c31cbb0b72279f481468c7c0f10da8e">exec</a> (Real dt=0.0)=0</td></tr>
<tr class="separator:a8c31cbb0b72279f481468c7c0f10da8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4748911d3214925588db6ca4134c7645"><td class="memItemLeft" align="right" valign="top"><a id="a4748911d3214925588db6ca4134c7645"></a>
virtual ReturnType&#160;</td><td class="memItemRight" valign="bottom"><b>parallel_exec</b> (Real dt=0.0)=0</td></tr>
<tr class="separator:a4748911d3214925588db6ca4134c7645"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:afeaa7dba132ce30b077aee3da749f342"><td class="memItemLeft" align="right" valign="top"><a id="afeaa7dba132ce30b077aee3da749f342"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setupDynamics</b> (Real dt=0.0)=0</td></tr>
<tr class="separator:afeaa7dba132ce30b077aee3da749f342"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_attribs_class_s_p_h_1_1_global_static_variables"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_class_s_p_h_1_1_global_static_variables')"><img src="closed.png" alt="-"/>&#160;Static Public Attributes inherited from <a class="el" href="class_s_p_h_1_1_global_static_variables.html">SPH::GlobalStaticVariables</a></td></tr>
<tr class="memitem:ade84c016ddfa66794108619277313c82 inherit pub_static_attribs_class_s_p_h_1_1_global_static_variables"><td class="memItemLeft" align="right" valign="top">static Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_global_static_variables.html#ade84c016ddfa66794108619277313c82">physical_time_</a> = 0.0</td></tr>
<tr class="separator:ade84c016ddfa66794108619277313c82 inherit pub_static_attribs_class_s_p_h_1_1_global_static_variables"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class ReturnType&gt;<br />
class SPH::Dynamics&lt; ReturnType &gt;</h3>

<p>The base class for all dynamics This class contains the only two interface functions available for particle dynamics. An specific implementation should be realized. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a343c5cd5886c1c142ec2f995449029f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a343c5cd5886c1c142ec2f995449029f5">&#9670;&nbsp;</a></span>Dynamics()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ReturnType&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_s_p_h_1_1_dynamics.html">SPH::Dynamics</a>&lt; ReturnType &gt;::<a class="el" href="class_s_p_h_1_1_dynamics.html">Dynamics</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8c31cbb0b72279f481468c7c0f10da8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c31cbb0b72279f481468c7c0f10da8e">&#9670;&nbsp;</a></span>exec()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ReturnType&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual ReturnType <a class="el" href="class_s_p_h_1_1_dynamics.html">SPH::Dynamics</a>&lt; ReturnType &gt;::exec </td>
          <td>(</td>
          <td class="paramtype">Real&#160;</td>
          <td class="paramname"><em>dt</em> = <code>0.0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>The only two functions can be called from outside One is for sequential execution, the other is for parallel. </p>

<p>Implemented in <a class="el" href="class_s_p_h_1_1solid__dynamics_1_1_damping_by_splitting_with_random_choice.html#a6683a634b2b1111de2edb431127f3a86">SPH::solid_dynamics::DampingBySplittingWithRandomChoice</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_complex_splitting.html#aab72a36760c3aece72d77af78f420ef4">SPH::ParticleDynamicsComplexSplitting&lt; BodyType, ParticlesType, MaterialType, ContactBodyType, ContactParticlesType, ContactMaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_inner_splitting.html#a13491f17ee977720c34e4e9abbdf81c9">SPH::ParticleDynamicsInnerSplitting&lt; BodyType, ParticlesType, MaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_cell_list_splitting.html#a5bf8880e98e3e6fad74a66fdd5832fb0">SPH::ParticleDynamicsCellListSplitting&lt; BodyType, ParticlesType, MaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_relaxation_of_all_diffusion_species_r_k2.html#ac90349521ec2a782159bb2536722e3bb">SPH::RelaxationOfAllDiffusionSpeciesRK2&lt; BodyType, BaseParticlesType, BaseMaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_relaxation_of_all_diffusion_species_r_k2.html#ac90349521ec2a782159bb2536722e3bb">SPH::RelaxationOfAllDiffusionSpeciesRK2&lt; SolidBody, SolidParticles, Solid &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_complex_split.html#ae4dbe302151cd8480714b6067b2a6b74">SPH::ParticleDynamicsComplexSplit&lt; BodyType, ParticlesType, MaterialType, ContactBodyType, ContactParticlesType, ContactMaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_complex1_level.html#aca261736f91509514a40c753dd1f094e">SPH::ParticleDynamicsComplex1Level&lt; BodyType, ParticlesType, MaterialType, ContactBodyType, ContactParticlesType, ContactMaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_complex_with_update.html#aaf896d5e53129262f5b19d615da65d9f">SPH::ParticleDynamicsComplexWithUpdate&lt; BodyType, ParticlesType, MaterialType, ContactBodyType, ContactParticlesType, ContactMaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_mirror_boundary_condition_in_axis_direction.html#ad264e578081cd52ac89d8bc60d768ebd">SPH::MirrorBoundaryConditionInAxisDirection</a>, <a class="el" href="class_s_p_h_1_1fluid__dynamics_1_1_transport_velocity_formulation.html#a3b7fa8e5a3a34d2e6d98fedaff2098ab">SPH::fluid_dynamics::TransportVelocityFormulation</a>, <a class="el" href="class_s_p_h_1_1_mirror_boundary_condition_in_axis_direction_1_1_updating_ghost_states.html#ae7be0ee35b4ff7bacef49239635893b5">SPH::MirrorBoundaryConditionInAxisDirection::UpdatingGhostStates</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_complex.html#a53ce1f745fb2d83302b6b7fe31fab5ae">SPH::ParticleDynamicsComplex&lt; BodyType, ParticlesType, MaterialType, ContactBodyType, ContactParticlesType, ContactMaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_mirror_boundary_condition_in_axis_direction_1_1_bounding.html#ac622944b6264d988cabba73934f8caa5">SPH::MirrorBoundaryConditionInAxisDirection::Bounding</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_contact.html#a510dbed29600f5bb6ef735368a8fdf10">SPH::ParticleDynamicsContact&lt; BodyType, ParticlesType, MaterialType, ContactBodyType, ContactParticlesType, ContactMaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_contact.html#a510dbed29600f5bb6ef735368a8fdf10">SPH::ParticleDynamicsContact&lt; SPHBody, BaseParticles, BaseMaterial, SPHBody, BaseParticles, BaseMaterial &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_inner1_level.html#a280c838918dc59d14d7791fa8e0a2865">SPH::ParticleDynamicsInner1Level&lt; BodyType, ParticlesType, MaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_inner1_level.html#a280c838918dc59d14d7791fa8e0a2865">SPH::ParticleDynamicsInner1Level&lt; SolidBody, ElasticSolidParticles, ElasticSolid &gt;</a>, <a class="el" href="class_s_p_h_1_1_periodic_bounding_in_axis_direction.html#a948dc81791737e875ff86a4a2ea36508">SPH::PeriodicBoundingInAxisDirection</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_inner_with_update.html#a9869ba1af90841f0d0b252f9965cd96a">SPH::ParticleDynamicsInnerWithUpdate&lt; BodyType, ParticlesType, MaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_inner_with_update.html#a9869ba1af90841f0d0b252f9965cd96a">SPH::ParticleDynamicsInnerWithUpdate&lt; SolidBody, ElasticSolidParticles, ElasticSolid &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_inner.html#ac2ce5253347a4b936e6211da654e2a30">SPH::ParticleDynamicsInner&lt; BodyType, ParticlesType, MaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_inner.html#ac2ce5253347a4b936e6211da654e2a30">SPH::ParticleDynamicsInner&lt; SolidBody, ElasticSolidParticles, ElasticSolid &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_inner.html#ac2ce5253347a4b936e6211da654e2a30">SPH::ParticleDynamicsInner&lt; SPHBody &gt;</a>, <a class="el" href="class_s_p_h_1_1_get_diffusion_time_step_size.html#abbafdb225bf35578cb3d8d891f54b1e9">SPH::GetDiffusionTimeStepSize&lt; BodyType, BaseParticlesType, BaseMaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_get_diffusion_time_step_size.html#abbafdb225bf35578cb3d8d891f54b1e9">SPH::GetDiffusionTimeStepSize&lt; SolidBody, SolidParticles, Solid &gt;</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_particle_reduce.html#a1c3ea4816d0629dd5ddaf430e2da67d2">SPH::PartDynamicsByParticleReduce&lt; ReturnType, ReduceOperation, BodyType, ParticlesType, BodyPartByParticleType, MaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#a3ae63c9c60fbc2922c04682ccaecc620">SPH::ParticleDynamicsReduce&lt; ReturnType, ReduceOperation, BodyType, ParticlesType, MaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#a3ae63c9c60fbc2922c04682ccaecc620">SPH::ParticleDynamicsReduce&lt; Vecd, ReduceUpperBound, SPHBody &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#a3ae63c9c60fbc2922c04682ccaecc620">SPH::ParticleDynamicsReduce&lt; Vecd, ReduceLowerBound, SPHBody &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#a3ae63c9c60fbc2922c04682ccaecc620">SPH::ParticleDynamicsReduce&lt; Real, ReduceMax, SPHBody &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_reduce.html#a3ae63c9c60fbc2922c04682ccaecc620">SPH::ParticleDynamicsReduce&lt; bool, ReduceOR, SPHBody, BaseParticles &gt;</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_cell.html#aac4fa50529a6aaf83e5352983fd4bfa6">SPH::PartDynamicsByCell&lt; BodyType, ParticlesType, BodyPartByCellType, MaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_simple.html#ab98ebfad9077ba2fb92572c86a735c70">SPH::ParticleDynamicsSimple&lt; BodyType, ParticlesType, MaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_particle_dynamics_simple.html#ab98ebfad9077ba2fb92572c86a735c70">SPH::ParticleDynamicsSimple&lt; SPHBody, BaseParticles &gt;</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_particle.html#a502c0129babb798189cec15ed7c88c0f">SPH::PartDynamicsByParticle&lt; BodyType, ParticlesType, BodyPartByParticleType, MaterialType &gt;</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_particle.html#a502c0129babb798189cec15ed7c88c0f">SPH::PartDynamicsByParticle&lt; SolidBody, ActiveMuscleParticles, SolidBodyPartForSimbody &gt;</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_particle.html#a502c0129babb798189cec15ed7c88c0f">SPH::PartDynamicsByParticle&lt; SolidBody, ActiveMuscleParticles, BodyPartByParticle &gt;</a>, <a class="el" href="class_s_p_h_1_1_part_dynamics_by_particle.html#a502c0129babb798189cec15ed7c88c0f">SPH::PartDynamicsByParticle&lt; SolidBody, SolidParticles, SolidBodyPartForSimbody &gt;</a>, and <a class="el" href="class_s_p_h_1_1_part_dynamics_by_particle.html#a502c0129babb798189cec15ed7c88c0f">SPH::PartDynamicsByParticle&lt; SolidBody, SolidParticles, BodyPartByParticle &gt;</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>SPHINXsys/src/shared/particle_dynamics/<a class="el" href="base__particle__dynamics_8h_source.html">base_particle_dynamics.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
